Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request refactors the documentation and shared utilities for the Handler project to improve clarity, maintainability, and user experience. The most significant changes include streamlining the development guides, simplifying documentation for commands and architecture, and restructuring the common utilities by introducing a new formatting system and output interface. These updates make the codebase easier to understand and extend, and provide a more consistent developer and user experience.
Documentation improvements:
AGENTS.md,CONTRIBUTING.md,README.md: Simplified and restructured documentation by removing detailed command tables and architecture sections, consolidating instructions, and clarifying quick start and usage information. The guides now focus on essential setup and usage, with references to available commands and contributing instructions. [1] [2] [3]Common utilities refactor:
src/a2a_handler/common/__init__.py: Reorganized exports and replaced the old printing utilities with a new output system, removing functions likeprint_errorand introducingOutput,OutputMode, andget_output_context.src/a2a_handler/common/output.py: Added a new output formatting system that supports raw, text, and JSON modes, providing unified and mode-aware styling for CLI output.src/a2a_handler/common/formatting.py: Introduced new formatting utilities for field names and values, supporting human-readable display of structured data.Code documentation and style:
src/a2a_handler/__init__.py,src/a2a_handler/common/logging.py: Enhanced module docstrings to clarify the purpose and usage of each module. [1] [2]Tooling and configuration:
pyproject.toml: Added per-file linting ignores forsrc/a2a_handler/cli.pyto suppress import errors, improving the development experience.These changes collectively modernize the Handler project’s documentation and internal utilities, making it easier for new contributors to get started and for users to interact with the CLI and TUI interfaces.